home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / macros / texinfo / README < prev    next >
Text File  |  1994-01-28  |  7KB  |  157 lines
  1. Texinfo, Version 3
  2. ==================
  3.  
  4. This is the README file for version 3 of the Texinfo distribution.
  5. Files within this distribution have their own version and edition
  6. numbers.  When you refer to a file, please mention its own number.
  7.  
  8. 23 March 1993
  9.  
  10. Texinfo is a documentation system that uses a single source file to
  11. produce both on-line information and printed output.  This means that
  12. instead of writing two different documents, one for the on-line help
  13. or other on-line information and the other for a typeset manual or
  14. other printed work, you need write only one document.  When the work
  15. is revised, you need revise only one document.  You can read the
  16. on-line information, known as an "Info file", with an Info
  17. documentation-reading program.  By convention, Texinfo source file
  18. names end with a `.texi' or `.texinfo' extension.  Texinfo is
  19. described in the Texinfo Manual.
  20.  
  21. You can write and format Texinfo files into Info files within GNU
  22. Emacs, and read them using the Emacs Info reader.  If you do not have
  23. Emacs, you can format Texinfo files into Info files using `makeinfo'
  24. and read them using `info'.  Use TeX, which is not included in this
  25. package, to typeset Texinfo files for printing.
  26.  
  27. Please report bugs to: bug-texinfo@prep.ai.mit.edu
  28.  
  29. This distribution includes (but is not limited to) the following files:
  30.  
  31.     README                      This file.
  32.  
  33.     INTRODUCTION                This file tells you how to create
  34.                                 readable files from the Texinfo source
  35.                                 files in this distribution.
  36.  
  37. Texinfo source files:
  38.  
  39.     texinfo.texi                This manual describes Texinfo.  It
  40.                                 tells how to use Texinfo to write
  41.                                 documentation, how to use Texinfo mode
  42.                                 in GNU Emacs, how to use TeX,
  43.                                 makeinfo, and the Emacs Lisp Texinfo
  44.                                 formatting commands.
  45.  
  46.     info.texi                   This manual tells you how to use 
  47.                                 Info.  This document comes as part of
  48.                                 GNU Emacs.  If you do not have Emacs,
  49.                                 you can format this Texinfo source
  50.                                 file with makeinfo or TeX and then
  51.                                 read the resulting Info file with the
  52.                                 standalone Info reader that is part of
  53.                                 this distribution.
  54.  
  55.     info-stnd.texi              This manual tells you how to use
  56.                                 the standalone GNU Info reader that is
  57.                                 included in this distribution as a C
  58.                                 source file, `info.c'.
  59.  
  60.     makeinfo.texi               This manual tells you how to use
  61.                                 makeinfo.  The same information is
  62.                                 contained in a chapter of the Texinfo
  63.                                 manual; it has been extracted here for
  64.                                 your convenience.
  65.  
  66.  
  67. Printing related files:
  68.  
  69.     texinfo.tex                 This TeX definitions file tells
  70.                                 the TeX program how to typeset a
  71.                                 Texinfo file into a DVI file ready for
  72.                                 printing.
  73.  
  74.     texindex.c                  This file contains the source for
  75.                                 the `texindex' program that generates
  76.                                 sorted indices used by TeX when
  77.                                 typesetting a file for printing.
  78.  
  79.     texi2dvi                    This is a shell script for
  80.                                 producing an indexed DVI file using
  81.                                 TeX and texindex.
  82.  
  83.  
  84. GNU Emacs related files:
  85.  
  86.     texinfmt.el                 This Emacs Lisp file provides the
  87.                                 functions that GNU Emacs uses to
  88.                                 format a Texinfo file into an Info
  89.                                 file.
  90.  
  91.     texinfo.el                  This file provides Texinfo mode
  92.                                 for GNU Emacs.
  93.  
  94.     texnfo-upd.el               These files provides commands to
  95.     texnfo-tex.el               help you write Texinfo files
  96.     makeinfo.el                 using GNU Emacs Texinfo mode.
  97.  
  98.     detexinfo.el                This extra utility file contains functions 
  99.                                 to remove Texinfo commands from a
  100.                                 Texinfo source file.
  101.  
  102.     info.el                     These are the standard GNU Emacs
  103.     informat.el                 Info reading and support files,
  104.                                 included here for your convenience.
  105.  
  106.  
  107. Source files for standalone C programs:
  108.  
  109.     makeinfo.c                  This file contains the source for
  110.                                 the `makeinfo' program that you can
  111.                                 use to create an Info file from a
  112.                                 Texinfo file.
  113.  
  114.     info.c                      This file contains the source for
  115.                                 the `info' program that you can use to
  116.                                 view Info files on an ASCII terminal.
  117.  
  118.     getopt.c                    Various support files
  119.     getopt1.c
  120.     getopt.h
  121.  
  122.  
  123. C Installation files:
  124.  
  125.     configure                   This file creates creates a Makefile 
  126.                                 which in turn creates an `info' or
  127.                                 `makeinfo' executable, or a C sources
  128.                                 distribution.
  129.  
  130.     configure.in                This is a template for creating 
  131.                                 `configure' using m4 macros.
  132.  
  133.     Makefile.in                 This is a template for `configure' 
  134.                                 to use to make a Makefile.
  135.                                
  136.  
  137. Other files:
  138.  
  139.     NEWS                        This contains a summary of new
  140.                                 features since the first edition 
  141.                                 of Texinfo.
  142.  
  143.     info.1                      This is a `man' page that briefly 
  144.                                 describes the standalone `info'
  145.                                 program.
  146.  
  147.     fixfonts                    This is a shell script to install the 
  148.                                 `lcircle10' TeX fonts as an alias for
  149.                                 the `circle10' fonts.  In some older
  150.                                 TeX distributions the names are
  151.                                 different.
  152.  
  153.     tex3patch                   This handles a bug for version
  154.                                 3.0 of TeX that does not occur in
  155.                                 more recent versions.
  156.  
  157.